home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1996 February: Tool Chest / Apple Developer CD Series Tool Chest February 1996 (Apple Computer)(1996).iso / Tool Chest / Interfaces & Libraries / Interfaces / AIncludes / Editions.a < prev    next >
Encoding:
Text File  |  1993-11-30  |  11.2 KB  |  483 lines  |  [TEXT/MPS ]
  1. ;    File:        Editions.a
  2. ;
  3. ;    Copyright:    © 1983-1993 by Apple Computer, Inc.
  4. ;                All rights reserved.
  5. ;
  6. ;    Version:    System 7.1 for ETO #11
  7. ;    Created:    Tuesday, March 30, 1993 18:00
  8. ;
  9. ;___________________________________________________________________________
  10.  
  11.     IF &TYPE('__INCLUDINGEDITIONS__') = 'UNDEFINED' THEN
  12. __INCLUDINGEDITIONS__    SET    1
  13.  
  14.     IF &TYPE('__INCLUDINGFSEQU__') = 'UNDEFINED' THEN        ; get definition of FSSpec
  15.     INCLUDE     'FSEqu.a'
  16.     ENDIF
  17.  
  18.  
  19.  
  20. ; resource types 
  21. rSectionType                EQU     'sect'
  22.  
  23. ; section types 
  24. stSubscriber                EQU     $01
  25. stPublisher                 EQU     $0A
  26.  
  27. ; Update Modes 
  28. sumAutomatic                EQU        0    ; subscriber update mode - Automatically 
  29. sumManual                    EQU        1    ; subscriber update mode - Manually 
  30. pumOnSave                    EQU        0    ; publisher update mode - On Save 
  31. pumManual                    EQU        1    ; publisher update mode - Manually 
  32.     
  33. ; EditionContainer subpart usage 
  34. kPartsNotUsed                EQU         0
  35. kPartNumberUnknown            EQU        -1
  36.  
  37. ; preview size 
  38. kPreviewWidth                EQU        120
  39. kPreviewHeight                EQU        120
  40.  
  41. ; special formats 
  42. kPublisherDocAliasFormat    EQU        'alis'     ; same as rAliasType
  43. kPreviewFormat                EQU        'prvw'
  44. kFormatListFormat            EQU        'fmts'
  45.  
  46. ; bits for formatsMask 
  47. kPICTformatMask                EQU        1
  48. kTEXTformatMask                EQU        2
  49. ksndFormatMask                EQU        4
  50.  
  51. ; Finder types for edition files 
  52. kPICTEditionFileType        EQU        'edtp'
  53. kTEXTEditionFileType        EQU        'edtt'
  54. ksndEditionFileType            EQU        'edts'
  55. kUnknownEditionFileType        EQU        'edtu'
  56.  
  57. ; pseudo-item hits for dialogHooks 
  58. ; the first is for NewPublisher or NewSubscriber Dialogs 
  59. emHookRedrawPreview            EQU     150
  60. ; the following are for SectionOptions Dialog 
  61. emHookCancelSection            EQU        160    
  62. emHookGoToPublisher            EQU        161
  63. emHookGetEditionNow            EQU        162
  64. emHookSendEditionNow        EQU        162
  65. emHookManualUpdateMode        EQU        163
  66. emHookAutoUpdateMode        EQU        164
  67.  
  68.  
  69. ; the refcon field of the dialog record in a modalfilter or 
  70. ; dialoghook during SectionOptionsDialog contains one the following 
  71. emOptionsDialogRefCon        EQU        'optn'
  72. emCancelSectionDialogRefCon    EQU        'cncl'
  73. emGoToPubErrDialogRefCon    EQU        'gerr'
  74.  
  75.  
  76. ; misc 
  77. kFormatLengthUnknown        EQU        -1
  78.  
  79.  
  80. ; record definitions
  81. ;
  82. SectionRecord    RECORD    0
  83. version            DS.B    1    ;    SignedByte         { always 1 in 7.0 release }
  84. kind            DS.B    1    ;    SectionType        { publisher or subscriber }
  85. mode            DS.W    1    ;    UpdateMode         { auto or manual }
  86. mdDate             DS.L    1    ;    TimeStamp        { version of data in section }
  87. sectionID        DS.L    1    ;    LONGINT            { application specific, unique per document }
  88. refCon             DS.L    1    ;    LONGINT            { application specific }
  89. alias            DS.L    1    ;    AliasHandle        { handle to Alias Record }
  90. ; the following fields are private and set up by RegisterSection 
  91. subPart            DS.L    1    ;    LONGINT            { which part of container,  always kPartsNotUsed in 7.0 }
  92. nextSection        DS.L    1    ;    SectionHandle    { for linked list of app's Sections }
  93. controlBlock    DS.L    1    ;    Handle            { shared controlblock for this section. }
  94. refNum             DS.L    1    ;    EditionRefNum    { NIL outside of Open/CloseEdition }
  95. size            EQU        *
  96.                 ENDR
  97.  
  98.  
  99. EditionContainerSpec RECORD 0
  100. theFile                DS        FSSpec                 ;
  101. theFileScript        DS.W    1                     ;    ScriptCode
  102. thePart                DS.L    1                     ;    LONGINT
  103. thePartName            DS.B    32                     ;    Str31
  104. thePartScript        DS.W    1                     ;    ScriptCode
  105. size                EQU        *
  106.                     ENDR        
  107.  
  108.  
  109. EditionInfoRecord    RECORD 0
  110. crDate                DS.L    1                     ;     Timestamp        { date EditionContainer was created }
  111. mdDate                DS.L    1                     ;     Timestamp        { date of last change }
  112. fdCreator            DS.B    4                     ;     OSType            { file creator }
  113. fdType                DS.B    4                     ;     OSType         { file type, 'edtT', etc }
  114. container            DS        EditionContainerSpec ;                    { the Edition }
  115. size                EQU        *
  116.                     ENDR
  117.  
  118. NewPublisherReply    RECORD 0
  119. canceled            DS.B    1                     ;    BOOLEAN            { O }
  120. replacing            DS.B    1                     ;    BOOLEAN            { O }    
  121. usePart                DS.B    1                     ;    BOOLEAN            { I }
  122. pad1                DS.B    1                     ;    
  123. preview                DS.L    1                     ;    Handle             { I }
  124. previewFormat        DS.B    4                     ;    FormatType         { I }
  125. container            DS        EditionContainerSpec ;                    { I/O }
  126. size                EQU        *
  127.                     ENDR
  128.  
  129. NewSubscriberReply    RECORD 0
  130. canceled            DS.B    1                     ;    BOOLEAN            { O }
  131. formatsMask            DS.B    1                     ;    SignedByte        { I }
  132. container            DS        EditionContainerSpec ;                    { I/O }
  133. size                EQU        *
  134.                     ENDR
  135.  
  136. SectionOptionsReply RECORD 0
  137. canceled            DS.B    1                     ;    BOOLEAN            { O }
  138. changed                DS.B    1                     ;    BOOLEAN            { O }
  139. sectionH            DS.L    1                     ;    SectionHandle    { I }
  140. action                DS.B    4                     ;     ResType            { 0 }
  141. size                EQU        *
  142.                     ENDR
  143.  
  144.  
  145. ; FormatIOVerb's
  146. ioHasFormat            EQU        0
  147. ioReadFormat        EQU        1
  148. ioNewFormat            EQU        2
  149. ioWriteFormat        EQU        3
  150.  
  151. FormatIOParamBlock    RECORD 0
  152. ioRefNum            DS.L    1                     ;    LONGINT
  153. format                DS.B    4                     ;     FormatType
  154. formatIndex            DS.L    1                     ;    LONGINT
  155. offset                DS.L    1                     ;     LONGINT
  156. buffPtr                DS.L    1                     ;    Ptr
  157. buffLen                DS.L    1                     ;    LONGINT
  158. size                EQU        *
  159.                     ENDR
  160.  
  161.  
  162. ; EditionOpenerVerb's
  163. eoOpen                EQU        0
  164. eoClose                EQU        1
  165. eoOpenNew            EQU        2
  166. eoCloseNew            EQU        3
  167. eoCanSubscribe        EQU        4
  168.  
  169. EditionOpenerParamBlock RECORD 0
  170. info                DS        EditionInfoRecord     ;
  171. sectionH            DS.L    1                     ;    SectionHandle
  172. document            DS.L    1                     ;    FSSpecPtr
  173. fdCreator            DS.B    4                     ;    OSType
  174. ioRefNum            DS.L    1                     ;    LONGINT
  175. ioProc                DS.L    1                     ;     FormatIOProcPtr
  176. success                DS.B    1                     ;    BOOLEAN
  177. formatsMask            DS.B    1                     ;    SignedByte    
  178. size                EQU        *
  179.                         ENDR
  180.  
  181.  
  182. ; Section Events
  183. sectionEventMsgClass    EQU     'sect'
  184. sectionReadMsgID        EQU     'read'
  185. sectionWriteMsgID        EQU     'writ'
  186. sectionScrollMsgID        EQU     'scrl'
  187. sectionCancelMsgID        EQU     'cncl'
  188.     
  189. ; 
  190. ;    Section events now arrive in the message buffer using the AppleEvent format.
  191. ;    The direct object parameter is an aeTemporaryIDParamType ('tid '). The temporary
  192. ;    ID's type is rSectionType ('sect') and the 32-bit value is a SectionHandle.
  193. ;    The following is a sample buffer
  194. ;    
  195. ;    name            offset    contents
  196. ;    ----            ------    --------
  197. ;    
  198. ;    header            0        'aevt'
  199. ;    majorVersion    4        $01
  200. ;    minorVersion    6        $01
  201. ;    endOfMetaData    8        ';;;;' 
  202. ;    directObjKey    12        '----' 
  203. ;    paramType        16        'tid ' 
  204. ;    paramLength        20        $0008 
  205. ;    tempIDType        24        'sect' 
  206. ;    tempID             28        the SectionHandle <-- this is want you want
  207. ;
  208.  
  209.     
  210. ;    FUNCTION InitEditionPack: OSErr;
  211.         MACRO
  212.         _InitEditionPack
  213.         MOVE.W     #$0011,-(SP)
  214.         MOVE.W     #$0100,D0
  215.         _Pack11
  216.         ENDM
  217.  
  218.  
  219. ;    FUNCTION NewSection(container: EditionContainerSpec;
  220. ;                        sectionDocument: FSSpecPtr; 
  221. ;                        kind: SectionType;
  222. ;                        sectionID: LONGINT;
  223. ;                        initalMode: UpdateMode; 
  224. ;                        VAR sectionH: SectionHandle): OSErr;
  225.         MACRO
  226.         _NewSection
  227.         MOVE.W     #$0A02,D0
  228.         _Pack11
  229.         ENDM
  230.  
  231.     
  232. ;    FUNCTION RegisterSection(sectionDocument: FSSpec; sectionH: SectionHandle;
  233. ;                            VAR aliasWasUpdated: BOOLEAN): OSErr;
  234.         MACRO
  235.         _RegisterSection
  236.         MOVE.W     #$0604,D0
  237.         _Pack11
  238.         ENDM
  239.  
  240.     
  241.  
  242. ;    FUNCTION UnRegisterSection(sectionH: SectionHandle): OSErr;
  243.         MACRO
  244.         _UnRegisterSection
  245.         MOVE.W     #$0206,D0
  246.         _Pack11
  247.         ENDM
  248.  
  249.  
  250.  
  251. ;    FUNCTION IsRegisteredSection(sectionH: SectionHandle): OSErr;
  252.         MACRO
  253.         _IsRegisteredSection
  254.         MOVE.W     #$0208,D0
  255.         _Pack11
  256.         ENDM
  257.  
  258.  
  259.     
  260. ;    FUNCTION AssociateSection(sectionH: SectionHandle; newSectionDocument: FSSpecPtr): OSErr;
  261.         MACRO
  262.         _AssociateSection
  263.         MOVE.W     #$040C,D0
  264.         _Pack11
  265.         ENDM
  266.  
  267.     
  268. ;    FUNCTION CreateEditionContainerFile(editionFile: FSSpec; fdCreator: OSType;
  269. ;                                        editionFileNameScript: ScriptCode): OSErr;
  270.         MACRO
  271.         _CreateEditionContainerFile
  272.         MOVE.W     #$050E,D0
  273.         _Pack11
  274.         ENDM
  275.     
  276.     
  277. ;    FUNCTION DeleteEditionContainerFile(editionFile: FSSpec): OSErr;
  278.         MACRO
  279.         _DeleteEditionContainerFile
  280.         MOVE.W     #$0210,D0
  281.         _Pack11
  282.         ENDM
  283.     
  284.         
  285.     
  286. ;    FUNCTION OpenEdition(subscriberSectionH: SectionHandle; 
  287. ;                            VAR refNum: EditionRefNum): OSErr;
  288.         MACRO
  289.         _OpenEdition
  290.         MOVE.W     #$0412,D0
  291.         _Pack11
  292.         ENDM
  293.     
  294.     
  295. ;    FUNCTION OpenNewEdition(publisherSectionH: SectionHandle; fdCreator: OSType;
  296. ;                            publisherSectionDocument: FSSpecPtr;
  297. ;                            VAR refNum: EditionRefNum): OSErr;
  298.         MACRO
  299.         _OpenNewEdition
  300.         MOVE.W     #$0814,D0
  301.         _Pack11
  302.         ENDM
  303.     
  304.     
  305. ;    FUNCTION CloseEdition(whichEdition: EditionRefNum; successful: BOOLEAN): OSErr;
  306.         MACRO
  307.         _CloseEdition
  308.         MOVE.W     #$0316,D0
  309.         _Pack11
  310.         ENDM
  311.  
  312.  
  313. ;    FUNCTION EditionHasFormat(whichEdition: EditionRefNum; whichFormat: FormatType;
  314. ;                                VAR formatSize: Size): OSErr;
  315.         MACRO
  316.         _EditionHasFormat
  317.         MOVE.W     #$0618,D0
  318.         _Pack11
  319.         ENDM
  320.     
  321.     
  322. ;    FUNCTION ReadEdition(whichEdition: EditionRefNum; whichFormat: FormatType;
  323. ;                            buffPtr: Ptr; VAR buffLen: Size): OSErr;
  324.         MACRO
  325.         _ReadEdition
  326.         MOVE.W     #$081A,D0
  327.         _Pack11
  328.         ENDM
  329.     
  330.     
  331. ;    FUNCTION WriteEdition(whichEdition: EditionRefNum; whichFormat: FormatType;
  332. ;                            buffPtr: Ptr; buffLen: Size): OSErr;
  333.         MACRO
  334.         _WriteEdition
  335.         MOVE.W     #$081C,D0
  336.         _Pack11
  337.         ENDM
  338.     
  339.     
  340. ;    FUNCTION GetEditionFormatMark(whichEdition: EditionRefNum; whichFormat: FormatType;
  341. ;                                VAR currentMark: LONGINT): OSErr;
  342.         MACRO
  343.         _GetEditionFormatMark
  344.         MOVE.W     #$061E,D0
  345.         _Pack11
  346.         ENDM
  347.     
  348.     
  349. ;    FUNCTION SetEditionFormatMark(whichEdition: EditionRefNum; whichFormat: FormatType;
  350. ;                                setMarkTo: LONGINT): OSErr;
  351.         MACRO
  352.         _SetEditionFormatMark
  353.         MOVE.W     #$0620,D0
  354.         _Pack11
  355.         ENDM
  356.  
  357.  
  358.  
  359. ;    FUNCTION GetEditionInfo(sectionH: SectionHandle; VAR editionInfo: EditionInfoRecord): OSErr;
  360.         MACRO
  361.         _GetEditionInfo
  362.         MOVE.W     #$0422,D0
  363.         _Pack11
  364.         ENDM
  365.         
  366.         
  367. ;    FUNCTION GoToPublisherSection(container: EditionContainerSpec): OSErr;
  368.         MACRO
  369.         _GoToPublisherSection
  370.         MOVE.W     #$0224,D0
  371.         _Pack11
  372.         ENDM
  373.     
  374.     
  375. ;    FUNCTION GetLastEditionContainerUsed(VAR container: EditionContainerSpec): OSErr;    
  376.         MACRO
  377.         _GetLastEditionContainerUsed
  378.         MOVE.W     #$0226,D0
  379.         _Pack11
  380.         ENDM
  381.         
  382.         
  383. ;    FUNCTION GetStandardFormats(container: EditionContainerSpec; VAR previewFormat: FormatType;
  384. ;                                    preview, publisherAlias, formats: Handle): OSErr;
  385.         MACRO
  386.         _GetStandardFormats
  387.         MOVE.W     #$0A28,D0
  388.         _Pack11
  389.         ENDM
  390.     
  391.  
  392. ;    FUNCTION GetEditionOpenerProc(VAR opener: EditionOpenerProcPtr): OSErr;
  393.         MACRO
  394.         _GetEditionOpenerProc
  395.         MOVE.W     #$022A,D0
  396.         _Pack11
  397.         ENDM
  398.         
  399.  
  400. ;    FUNCTION SetEditionOpenerProc(opener: EditionOpenerProcPtr): OSErr;
  401.         MACRO
  402.         _SetEditionOpenerProc
  403.         MOVE.W     #$022C,D0
  404.         _Pack11
  405.         ENDM
  406.  
  407.  
  408. ;    FUNCTION CallEditionOpenerProc(selector: EditionOpenerVerb; VAR PB: EditionOpenerParamBlock;
  409. ;                            routine: EditionOpenerProcPtr): OSErr;
  410.         MACRO
  411.         _CallEditionOpenerProc
  412.         MOVE.W     #$052E,D0
  413.         _Pack11
  414.         ENDM
  415.  
  416.  
  417. ;    FUNCTION CallFormatIOProc(selector: FormatIOVerb; VAR PB: FormatIOParamBlock;
  418. ;                            routine: FormatIOProcPtr): OSErr;
  419.         MACRO
  420.         _CallFormatIOProc
  421.         MOVE.W     #$0530,D0
  422.         _Pack11
  423.         ENDM
  424.             
  425.  
  426.  
  427.  
  428. ;    FUNCTION NewSubscriberDialog(VAR reply: NewSubscriberReply): OSErr;
  429.         MACRO
  430.         _NewSubscriberDialog
  431.         MOVE.W     #$0232,D0
  432.         _Pack11
  433.         ENDM
  434.     
  435.     
  436. ;    FUNCTION NewSubscriberExpDialog(VAR reply: NewSubscriberReply; where: Point;
  437. ;                                    expansionDITLresID: INTEGER; dlgHook: ExpDlgHookProcPtr;
  438. ;                                    filterProc: ExpModalFilterProcPtr; yourDataPtr: UNIV Ptr): OSErr;
  439.         MACRO
  440.         _NewSubscriberExpDialog
  441.         MOVE.W     #$0B34,D0
  442.         _Pack11
  443.         ENDM
  444.     
  445.     
  446. ;    FUNCTION NewPublisherDialog(VAR reply: NewPublisherReply): OSErr;
  447.         MACRO
  448.         _NewPublisherDialog
  449.         MOVE.W     #$0236,D0
  450.         _Pack11
  451.         ENDM
  452.     
  453.     
  454. ;    FUNCTION NewPublisherExpDialog(VAR reply: NewPublisherReply; where: Point;
  455. ;                                    expansionDITLresID: INTEGER; dlgHook: ExpDlgHookProcPtr;
  456. ;                                    filterProc: ExpModalFilterProcPtr; yourDataPtr: UNIV Ptr): OSErr;
  457.         MACRO
  458.         _NewPublisherExpDialog
  459.         MOVE.W     #$0B38,D0
  460.         _Pack11
  461.         ENDM
  462.     
  463.     
  464. ;    FUNCTION SectionOptionsDialog(VAR reply: SectionOptionsReply): OSErr;
  465.         MACRO
  466.         _SectionOptionsDialog
  467.         MOVE.W     #$023A,D0
  468.         _Pack11
  469.         ENDM
  470.     
  471.     
  472. ;    FUNCTION SectionOptionsExpDialog(VAR reply: SectionOptionsReply; where: Point;
  473. ;                                    expansionDITLresID: INTEGER; dlgHook: ExpDlgHookProcPtr;
  474. ;                                    filterProc: ExpModalFilterProcPtr; yourDataPtr: UNIV Ptr): OSErr;
  475.         MACRO
  476.         _SectionOptionsExpDialog
  477.         MOVE.W     #$0B3C,D0
  478.         _Pack11
  479.         ENDM
  480.         
  481.  
  482.  
  483.     ENDIF    ; ...already included